/*
 * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package java.lang.annotation;

/**
  Indicates that annotations with a type are to be documented by javadoc 
  and similar tools by default.  
 指示JavaDoc将记录具有类型的注释
以及默认的类似工具。

This type should be used to annotate the declarations of types whose annotations affect the use of annotated
 elements by their clients.  
 此类型应用于对其批注影响已批注的使用的类型的声明进行批注。
由客户提供的元素。
 
 If a type declaration is annotated with
 Documented, its annotations become part of the public API of the annotated elements.
如果类型声明用注释
在文档中，它的注释成为带注释元素的公共API的一部分。



Documented 注解表明这个注解应该被 javadoc工具记录. 默认情况下,javadoc是不包括注解的. 但如果声明注解时指定了 @Documented,则它会被 javadoc 之类的工具处理, 所以注解类型信息也会被包括在生成的文档中. 示例6进一步演示了使用 @Documented:


java编程思想：此注解包含在JAVadoc中
 *
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}
